home *** CD-ROM | disk | FTP | other *** search
/ NetNews Offline 2 / NetNews Offline Volume 2.iso / news / comp / lang / c-part1 / 8831 < prev    next >
Encoding:
Text File  |  1996-08-05  |  2.6 KB  |  68 lines
  1. Newsgroups: comp.lang.c
  2. Path: surfnet.nl!sun4nl!hcsrnd!root
  3. From: paulw@gti-ia.nl (Paul Wallis)
  4. Subject: Re: C coding standards
  5. Message-ID: <DnuLzM.8xr@gti-ia.nl>
  6. Sender: root@gti-ia.nl (Operator)
  7. Reply-To: paulw@gti-ia.nl
  8. Organization: GTI Industrial Automation, Apeldoorn
  9. References: <313B4548.45AA@oc.com>
  10. Date: Wed, 6 Mar 1996 13:40:34 GMT
  11.  
  12. Teresa Reiko wrote:
  13. > In this book and others, notably 'Code Complete', these programming
  14. > guides published by Microsoft Press, it is evident why Microsoft put
  15. > so many bugs in Windows 95.  Here are the three worst Microsoft
  16. > coding rules, in my opinion at least:
  17. > 
  18. > Every line of code must contain a comment.
  19. > Any number greater than 2 must be a named constant.
  20. > No procedure may be longer than 25 lines.
  21. > 
  22. > If you follow these rules, you can be sure to write buggy, inefficient
  23. > code that is difficult to revise and will generally look 'dirty'.
  24. > Of course, if this is your intent, that's OK, but...
  25. >
  26. I am sorry, but I feel compelled to answer this, even though the debate does NOT
  27. belong in this newsgroup.  I believe IMHO that you have maligned an excellent book.
  28. I have read this book cover to cover and agreed with 90% of what the author says.
  29. And before you go on to 'slate' me, I think you aught to re-read the book and actually
  30. look at what is said.
  31.  
  32. The Code Complete definately does not say that every line should have a comment.
  33. In fact it says that you should be able to read what the code is meant to do without
  34. resorting to comments every line.  The author tries to put across the idea that
  35. comments bear a purpose and are not a cross to be born.
  36.  
  37. It suggests that a _guideline_ to function length would be one page long; going on
  38. to say that a page could be 25 lines 60 lines or even 120 lines depending upon wha
  39. you use for display.
  40.  
  41. As for ridiculing the fact that numbers greater than 2 should be a named constant.
  42. I really can't see your argument there.  It has, as far as I'm aware, always been
  43. common practice in the 'C' programming community to write:
  44.  
  45.     #define NAME_LIMIT 39
  46.     char    name[NAME_LIMIT];
  47.  
  48. as opposed to:
  49.  
  50.     char    name[39];
  51.  
  52. And IMHO the former is far easier to read an when you wish to upgrade or modify the
  53. length of a name you only have to change the #define as opposed to searching through
  54. all of your code for the number 39 and doing a replace...
  55.  
  56. Regards,
  57.     Paul
  58. ---
  59.  
  60.     =     =
  61.       ===   ===      GTI            Contact me at
  62.    ============      Industrial        paulw@gti-ia.nl
  63.         =     =      Automation b.v.    Of course my opinions 
  64.       ===   ===                    are my own?!  Who else
  65.    ============   The Netherlands       is that mad?!
  66.  
  67.  
  68.